Operation UserGroup.Suggestion (Get user/group suggestion)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Get the user/group list of the running instance. This is returning a blob containing a serialized JSON array..

Operation id	UserGroup.Suggestion
Category	Services
Label	Get user/group suggestion
Requires
Since

Parameters

Name	Description	Type	Required
allowSubGroupsRestriction	Whether to take into account subgroups when evaluating groupRestriction.	boolean	no
displayEmailInSuggestion		boolean	no
firstLabelField		string	no
groupRestriction	Enter the id of a group to suggest only user from this group.	string	no
hideAdminGroups	If set, remove all administrator groups from the suggestions	boolean	no
hideFirstLabel		boolean	no
hideIcon		boolean	no
hidePowerUsersGroup	If set, remove power users group from the suggestions	boolean	no
hideSecondLabel		boolean	no
hideThirdLabel		boolean	no
lang		string	no
searchTerm		string	no
searchType		string	no
secondLabelField		string	no
thirdLabelField		string	no
userSuggestionMaxSearchResults		integer	no

Signature

Inputs	void
Outputs	blob

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.users.SuggestUserEntries
Contributing Component	org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "UserGroup.Suggestion",
  "label" : "Get user/group suggestion",
  "category" : "Services",
  "requires" : null,
  "description" : "Get the user/group list of the running instance. This is returning a blob containing a serialized JSON array..",
  "url" : "UserGroup.Suggestion",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "allowSubGroupsRestriction",
    "description" : "Whether to take into account subgroups when evaluating groupRestriction.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "displayEmailInSuggestion",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "firstLabelField",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "groupRestriction",
    "description" : "Enter the id of a group to suggest only user from this group.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideAdminGroups",
    "description" : "If set, remove all administrator groups from the suggestions",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideFirstLabel",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideIcon",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hidePowerUsersGroup",
    "description" : "If set, remove power users group from the suggestions",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideSecondLabel",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "hideThirdLabel",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lang",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "searchTerm",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "searchType",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "secondLabelField",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "thirdLabelField",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "userSuggestionMaxSearchResults",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}